kanzi::TextBlock3D Class Reference

Text Block 3D displays a small amount of text in 3D. More...

#include <kanzi/ui/node/text_block3d.hpp>

Inheritance diagram for kanzi::TextBlock3D:
kanzi::TextBlockConceptImpl< Node3D, TextBlock3D > kanzi::Node3D kanzi::TextBlockConcept kanzi::Node kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Public Types

typedef TextBlockConceptImpl< Node3D, TextBlock3DConceptClass
 
- Public Types inherited from kanzi::Node3D
typedef Vector3 LayoutVectorType
 
typedef Matrix4x4 LayoutMatrixType
 
typedef vector< Node3DSharedPtrChildContainer
 Iterators for children. More...
 
typedef ChildContainer::const_iterator ChildConstIterator
 
typedef ChildContainer::const_reverse_iterator ChildConstReverseIterator
 
- Public Types inherited from kanzi::Node
enum  HorizontalAlignment { HorizontalAlignmentLeft, HorizontalAlignmentRight, HorizontalAlignmentCenter, HorizontalAlignmentStretch }
 Horizontal alignment options. More...
 
enum  VerticalAlignment { VerticalAlignmentBottom, VerticalAlignmentTop, VerticalAlignmentCenter, VerticalAlignmentStretch }
 Vertical alignment options. More...
 
enum  DepthAlignment { DepthAlignmentBack, DepthAlignmentFront, DepthAlignmentCenter, DepthAlignmentStretch }
 Depth alignment options. More...
 
enum  ContentStretch {
  ContentStretchNone, ContentStretchFill, ContentStretchUniform, ContentStretchUniformToFill,
  ContentStretchRepeat
}
 Content stretch option. More...
 
enum  VisitorOrder { VisitorPreOrder, VisitorPostOrder }
 
enum  VisitorResult { VisitorAbort, VisitorContinue, VisitorContinueSibling }
 
typedef kanzi::vector< Node::MessageSubscriptionTokenMessageSubscriptionTokenVector
 
typedef function< VisitorResult(Node &)> Visitor
 
typedef vector< InputManipulatorSharedPtrInputManipulatorContainer
 Gets the input manipulator iterator. More...
 
typedef InputManipulatorContainer::iterator InputManipulatorIterator
 
typedef InputManipulatorContainer::const_iterator InputManipulatorConstIterator
 
typedef vector< BindingEntryBindingContainer
 Gets the bindings iterator. More...
 
typedef BindingContainer::iterator BindingIterator
 
typedef BindingContainer::const_iterator BindingConstIterator
 
typedef vector< NodeComponentEntryNodeComponentContainer
 Gets the node component iterator. More...
 
typedef NodeComponentContainer::iterator NodeComponentIterator
 
typedef NodeComponentContainer::const_iterator NodeComponentConstIterator
 
- Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Public Types inherited from kanzi::TextBlockConcept
enum  TextHorizontalAlignment { TextHorizontalAlignmentLeft, TextHorizontalAlignmentRight, TextHorizontalAlignmentCenter }
 Horizontal alignment options for text layout. More...
 
enum  TextVerticalAlignment { TextVerticalAlignmentTop, TextVerticalAlignmentBaseline, TextVerticalAlignmentCenter, TextVerticalAlignmentBottom }
 Vertical alignment options for text layout. More...
 

Public Member Functions

virtual ~TextBlock3D ()
 Destructor. More...
 
virtual void restoreResources () KZ_OVERRIDE
 Node::restoreResources() implementation. More...
 
MaterialRenderergetMaterialRenderer ()
 Access material renderer. More...
 
TextureSharedPtr getGlyphTexture () const
 Access glyph texture. More...
 
- Public Member Functions inherited from kanzi::TextBlockConceptImpl< Node3D, TextBlock3D >
float getFontSize () const
 Gets the value of the FontSizeProperty. More...
 
void setFontSize (float value)
 Sets the value of the FontSizeProperty. More...
 
MaterialSharedPtr getFontMaterial () const
 Gets the value of the FontMaterialProperty. More...
 
void setFontMaterial (MaterialSharedPtr value)
 Sets the value of the FontMaterialProperty. More...
 
ColorRGBA getFontColor () const
 Gets the value of the FontColorProperty. More...
 
void setFontColor (ColorRGBA value)
 Sets the value of the FontColorProperty. More...
 
TextHorizontalAlignment getTextHorizontalAlignment () const
 Gets the value of the TextHorizontalAlignmentProperty. More...
 
void setTextHorizontalAlignment (TextHorizontalAlignment value)
 Sets the value of the TextHorizontalAlignmentProperty. More...
 
TextVerticalAlignment getTextVerticalAlignment () const
 Gets the value of the TextVerticalAlignmentProperty. More...
 
void setTextVerticalAlignment (TextVerticalAlignment value)
 Sets the value of the TextVerticalAlignmentProperty. More...
 
float getLineSpacing () const
 Gets the value of the LineSpacingProperty. More...
 
void setLineSpacing (float value)
 Sets the value of the LineSpacingProperty. More...
 
float getCharacterSpacing () const
 Gets the value of the CharacterSpacingProperty. More...
 
void setCharacterSpacing (float value)
 Sets the value of the CharacterSpacingProperty. More...
 
float getFixedCharacterWidth () const
 Gets the value of the FixedCharacterWidthProperty. More...
 
void setFixedCharacterWidth (float value)
 Sets the value of the FixedCharacterWidthProperty. More...
 
string getOverflow () const
 Gets the value of the OverflowProperty. More...
 
void setOverflow (string_view value)
 Sets the value of the OverflowProperty. More...
 
string getText () const
 Gets the value of TextProperty. More...
 
void setText (string value)
 Sets the value of TextProperty. More...
 
bool isWordWrap () const
 Gets the value of WordWrapProperty. More...
 
void setWordWrap (bool value)
 Sets the value of WordWrapProperty. More...
 
bool isConstrainContentHeight () const
 Gets the value of ConstrainContentHeightProperty. More...
 
void setConstrainContentHeight (bool value)
 Sets the value of ConstrainContentHeightProperty. More...
 
Vector2 getHorizontalPadding () const
 Gets the value of HorizontalPaddingProperty. More...
 
void setHorizontalPadding (Vector2 value)
 Sets the value of HorizontalPaddingProperty. More...
 
Vector2 getVerticalPadding () const
 Gets the value of VerticalPaddingProperty. More...
 
void setVerticalPadding (Vector2 value)
 Sets the value of VerticalPaddingProperty. More...
 
FontHintingPreference getHintingPreference () const
 Gets the value of HintingPreferenceProperty. More...
 
void setHintingPreference (FontHintingPreference hintingPreference)
 Sets the value of HintingPreferenceProperty. More...
 
KzcRectangle getTextBounds () const
 Get bounding rectangle for the text. More...
 
- Public Member Functions inherited from kanzi::Node3D
Matrix4x4 getFinalTransformation () const
 Gets the value of FinalTransformationProperty. More...
 
void setFinalTransformation (Matrix4x4 value)
 Sets the value of FinalTransformationProperty. More...
 
float getFrustumCullMargin () const
 Gets the value of FrustumCullMarginProperty. More...
 
void setFrustumCullMargin (float value)
 Sets the value of FrustumCullMarginProperty. More...
 
SRTValue3D getRenderTransformation () const
 Gets the value of RenderTransformationProperty. More...
 
void setRenderTransformation (SRTValue3D value)
 Sets the value of RenderTransformationProperty. More...
 
SRTValue3D getLayoutTransformation () const
 Gets the value of LayoutTransformationProperty. More...
 
void setLayoutTransformation (SRTValue3D value)
 Sets the value of LayoutTransformationProperty. More...
 
virtual ~Node3D ()
 
size_t getChildCount () const
 Gets child count from object. More...
 
Node3DSharedPtr getChild (size_t index) const
 Returns a child from given index from object node. More...
 
size_t getChildIndex (const Node &child) const
 Returns the index of a child in an object node. More...
 
bool hasChild (const Node &child) const
 Returns whether or not the child exists. More...
 
void addChild (const Node3DSharedPtr &child)
 Adds a child node for object node. More...
 
void insertChild (size_t index, const Node3DSharedPtr &child)
 Adds a child node for object node to given index. More...
 
void removeChild (const Node &child)
 Removes child node from parent object. More...
 
void removeChild (size_t index)
 Removes child node from parent object node at specified index. More...
 
void removeAllChildren ()
 Removes all child nodes from parent object. More...
 
ChildConstIterator beginChildren () const
 
ChildConstIterator endChildren () const
 
ChildConstReverseIterator rbeginChildren () const
 
ChildConstReverseIterator rendChildren () const
 
virtual bool addAbstractChildOverride (NodeSharedPtr child) KZ_OVERRIDE
 
virtual size_t getAbstractChildCountOverride () KZ_OVERRIDE
 
virtual NodeSharedPtr getAbstractChildOverride (size_t index) KZ_OVERRIDE
 
virtual bool removeAbstractChildOverride (Node &child) KZ_OVERRIDE
 
void moveToBack ()
 Repositions the node to the beginning of its parent's children, so that it is drawn first. More...
 
void moveToFront ()
 Repositions the node to the end of its parent's children, so that it is drawn last. More...
 
void setAutoWidth ()
 Sets node to automatically determine width. More...
 
void setAutoHeight ()
 Sets node to automatically determine height. More...
 
void setAutoDepth ()
 Sets node to automatically determine depth. More...
 
void setAutoSize ()
 Sets node to automatically determine width, height and depth. More...
 
void setSize (float width, float height, float depth)
 Sets size properties of the node. More...
 
void setCoreDesiredSize (const Vector3 &coreDesiredSize)
 Set core desired size for an object. More...
 
Vector3 getCoreDesiredSize () const
 Get core desired size of an object. More...
 
void setDesiredSize (const Vector3 &desiredSize)
 Set desired size for an object. More...
 
Vector3 getDesiredSize () const
 Get desired size for of object. More...
 
void setAllocatedSize (const Vector3 &layoutSize)
 Set allocated size for an object. More...
 
Vector3 getAllocatedSize () const
 Get allocated size of an object. More...
 
void setActualSize (const Vector3 &actualSize)
 Set actual size for an object. More...
 
Vector3 getActualSize () const
 Get actual size of an object. More...
 
void setLayoutBoundingBoxSize (const Vector3 &bboxMin, const Vector3 &bboxMax)
 Set bounding box size for an object. More...
 
void getLayoutBoundingBoxSize (Vector3 &bboxMin, Vector3 &bboxMax) const
 Get bounding box size for an object. More...
 
void setAllocatedOffset (const Vector3 &allocatedOffset)
 Set allocated offset for an object. More...
 
Vector3 getAllocatedOffset () const
 Get allocated offset of an object. More...
 
void setStretchScale (const Vector3 &stretchScale)
 Set stretch scale for an object. More...
 
Vector3 getStretchScale () const
 Get stretch scale of an object. More...
 
void setPivotOffset (const Vector3 &pivotOffset)
 Set pivot offset for an object. More...
 
Vector3 getPivotOffset () const
 Get pivot offset of an object. More...
 
kzsError getSize (Vector3 &out_size) const
 Returns the size of object node. More...
 
kzsError getMaximumBoundingBoxCoordinates (Vector3 &out_size) const
 Returns the minimum coordinates for object nodes bounding volume. More...
 
kzsError getMinimumBoundingBoxCoordinates (Vector3 &out_size) const
 Returns the maximum coordinates for object nodes bounding volume. More...
 
void setArrangeTransformation (const Matrix4x4 &value)
 Sets the layout transformation of the object. More...
 
Matrix4x4 getArrangeTransformation () const
 Gets the layout transformation of the object. More...
 
void layout ()
 Recursively calculate the layouts in the scene. More...
 
void measureIterate ()
 Initial scene measure. More...
 
virtual bool measureRecursive ()
 Perform layout measurement on a node. More...
 
void arrangeIterate ()
 Initial scene arrange. More...
 
void arrangeIterateLayout (bool propagateArrange)
 
void arrangeIterateLayoutChild (bool propagateArrange)
 
void measure (const Vector3 &availableSize)
 Perform the default measure step. More...
 
void arrange ()
 Perform layout arrangement on a node. More...
 
Vector3 centeredMeasure (Vector3 availableSize) const
 Default implementation of measure for a layout that accommodates all children at its center. More...
 
void centeredArrange (Vector3 actualSize) const
 Default implementation of arrange for a layout that accommodates all children at its center. More...
 
bool isPrimitiveLayout () const
 
void render (RenderPass &renderPass, const KzuTransformedObjectNode &transformedNode)
 Render function which passes the control to the render pass which executes the rendering. More...
 
Node3DSharedPtr getLookAtTarget () const
 
Node3DSharedPtr getPositionConstraintTarget () const
 
Node3DSharedPtr getOrientationConstraintTarget () const
 
Node3DSharedPtr getFaceToCameraTarget () const
 
- Public Member Functions inherited from kanzi::Node
virtual ~Node ()
 Destructor. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetNodeFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
DataType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::DataType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message handler where handler is a method to invoke on an object. More...
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message filter where filter is a method to invoke on an object. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message handler where handler is function. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message filter where filter is function. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
 Adds a message handler where handler is function and accepted source is explicitly defined. More...
 
void removeMessageHandler (MessageSubscriptionToken token)
 Removes a message subscription. More...
 
template<typename TArgumentsType >
void dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
 Dispatches a message with specified arguments. More...
 
void addResource (const ResourceID &resourceId, string_view resourceUrl)
 Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. */. More...
 
void removeResource (const ResourceID &resourceId)
 Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. */. More...
 
bool containsResource (const ResourceID &resourceID) const
 Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. */. More...
 
optional< string > findResourceURL (const ResourceID &resourceId) const
 Tries to find Resource URL for Resource ID from this node. More...
 
ResourceSharedPtr acquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...
 
template<typename T >
shared_ptr< T > acquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary, and casts the resource to given type. More...
 
ResourceSharedPtr tryAcquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...
 
ResourceManager::AcquireTaskSharedPtr acquireResourceAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const
 Posts an asynchronous task to acquire a resource. More...
 
template<typename T >
shared_ptr< T > tryAcquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource and casts the resource to given type. More...
 
ResourceDictionarySharedPtr getResourceDictionary () const
 Gets the resource dictionary of the node, if the node has one. More...
 
ResourceDictionarySharedPtr acquireResourceDictionary ()
 Gets the resource dictionary of the node. More...
 
void notifyResourceDictionaryModified ()
 Forces the re-evaluation of resource IDs in a node tree. More...
 
void setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 Replaces the resource dictionary of the node. More...
 
void addResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 Add a nested resource dictionary to the resource dictionary of the node. More...
 
void addAnonymousResource (ResourceSharedPtr resource)
 Adds alias resource to an object node. More...
 
void removeAnonymousResource (const Resource &resource)
 Removes anonymous resource from object node resources. More...
 
bool isNamed (string_view name) const
 
NodegetParent () const
 Returns the parent of the node. More...
 
void setParent (Node *parent)
 
VisitorResult visit (const Visitor &visitor, VisitorOrder order)
 
VisitorResult visitDescendants (const Visitor &visitor, VisitorOrder order)
 
template<typename Type >
shared_ptr< Type > lookupNode (string_view pathOrKey)
 Returns a node of specified type by looking it up with specified path or alias. More...
 
NodelookupNodeRaw (string_view relativePath)
 Get an object node by another node and a relative path. More...
 
ObjectSharedPtr lookupObject (string_view relativePath)
 Lookup for an object from a node. More...
 
tuple< NodeSharedPtr, AbstractPropertyTypelookupObjectForStateManager (string_view relativePath)
 Lookup for an node and possible object from within the node for state manager. More...
 
template<typename Type >
shared_ptr< Type > lookupObject (string_view path)
 Lookup for an object from a node. More...
 
template<typename TNodeType >
shared_ptr< TNodeType > findAbstractChild (string_view name)
 Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene. More...
 
void addInputManipulator (InputManipulatorSharedPtr inputManipulator)
 Transfers the ownership and attaches an input manipulator to an object node. More...
 
void removeInputManipulator (InputManipulator &inputManipulator)
 Removes the ownership and detaches an input manipulator from an object node. More...
 
InputManipulatorConstIterator beginInputManipulators () const
 
InputManipulatorConstIterator endInputManipulators () const
 
void addBinding (BindingSharedPtr binding)
 Transfers the ownership of a binding rule to an object node. More...
 
void addBindingWithOwner (BindingSharedPtr binding, shared_ptr< void > owner)
 Transfers the ownership of a binding rule to an object node and sets the owner of binding rule. More...
 
void removeBinding (Binding &binding)
 Removes the ownership and detaches a binding rule from an object node. More...
 
void removeBindingsWithOwner (shared_ptr< void > owner)
 Removes all bindings with the specified owner. More...
 
BindingConstIterator beginBindings () const
 
BindingConstIterator endBindings () const
 
void addNodeComponent (NodeComponentSharedPtr nodeComponent)
 Transfers the ownership of a node component to an object node. More...
 
void addNodeComponentWithOwner (NodeComponentSharedPtr nodeComponent, const void *owner)
 Transfers the ownership of a node component to an object node and sets the owner of the node component. More...
 
void removeNodeComponent (NodeComponent &nodeComponent)
 Removes the ownership of a node component from an object node. More...
 
void removeNodeComponentWithOwner (const void *owner)
 Removes all bindings with the specified owner. More...
 
NodeComponentConstIterator beginNodeComponents () const
 
NodeComponentConstIterator endNodeComponents () const
 
template<typename Type >
shared_ptr< Type > lookupNodeComponent (string_view name)
 Returns a node component of specified type by looking it up with specified name. More...
 
void setRenderable (bool state)
 Sets whether the object node is renderable. More...
 
bool isRenderable () const
 Returns whether node is renderable. More...
 
bool isEffectivelyVisible () const
 Checks if the node and all of its ancestors are visible. More...
 
bool isEffectivelyEnabled () const
 Checks if the node and all of its ancestors are enabled. More...
 
uint32_t getChangeFlags () const
 Get current change flags. More...
 
uint32_t getChildChangeFlags () const
 Get current child change flags. More...
 
void setChangeFlag (uint32_t flag)
 Sets a change flag. More...
 
void clearChangeFlag (uint32_t flag)
 Clears a change flag. More...
 
bool isChangeFlagSet (uint32_t flag) const
 Checks if a change flag is set. More...
 
bool isAnyChangeFlagSet (uint32_t flag) const
 Checks if any of given flags is set. More...
 
void setChildChangeFlag (uint32_t flag)
 Sets a child change flag. More...
 
void clearChildChangeFlag (uint32_t flag)
 Clears a child change flag. More...
 
bool isChildChangeFlagSet (uint32_t flag) const
 Checks if child change flags match. More...
 
bool isAnyChildChangeFlagSet (uint32_t flag) const
 Checks if any child change flags (corresponding to given mask) are set. More...
 
bool isInvalidMeasure () const
 Check if the node needs measure. More...
 
void invalidateMeasure ()
 Invalidates measure for the node. More...
 
void validateMeasure ()
 Validates measure for the node. More...
 
bool isInvalidArrange () const
 Checks if the node needs arrange. More...
 
void invalidateArrange ()
 Invalidates arrange. More...
 
void validateArrange ()
 Validates arrange. More...
 
bool isInvalidRender () const
 Returns if node render flag is invalid. More...
 
void validateRender ()
 Validates render for node. More...
 
void invalidateRender ()
 Invalidates render for node. More...
 
bool isInvalidFinalTransform () const
 Tells if final transform flag is invalid for node. More...
 
void invalidateFinalTransform ()
 Invalidates final transform for node. More...
 
bool isInvalidDraw ()
 Tells if node draw flag is invalid. More...
 
void invalidateDraw ()
 Invalidates draw flag for the node. More...
 
void validateDraw ()
 Validates draw flags for the node. More...
 
void validateDrawForChildrenRecursive ()
 Recursively validates draw for the children from this 2D node onwards. More...
 
bool isInitialized () const
 Returns true if initialize() has been called, false otherwise. More...
 
bool isAttached () const
 Returns true if the node is attached to a screen or one of its descendants. More...
 
bool isAttaching () const
 Returns true if node is in the process of attaching, false otherwise. More...
 
bool isDetaching () const
 Returns true if the node currently detaching. More...
 
void attachRecursive ()
 Attaches an object node and its children recursively. More...
 
void detachRecursive ()
 Detaches an object node and its children recursively. More...
 
AppliedStyleEntrySharedPtr applyStyle (StyleSharedPtr style)
 Applies a style to an object node. More...
 
AppliedStyleEntrySharedPtr applyManualStyle (StyleSharedPtr style)
 Applies a style to an object node. More...
 
void unapplyStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 Unapplies a style from an object node. More...
 
void applyStyles ()
 Apply all styles for an object node. More...
 
void unapplyStyles ()
 Unapplies and removes all applied styles. More...
 
void applyStylesRecursive ()
 Applies styles recursively. More...
 
void unapplyStylesRecursive ()
 Unapplies styles recursively. More...
 
void removeKZBData ()
 Destroys all object node data loaded from KZB, including properties, bindings, node comopnents, resources etc. More...
 
void addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference)
 This is a helper for automatic resource tracking in ResourceReference. More...
 
void removeResourceReference (const AbstractResourceReference &reference)
 This is a helper for automatic resource tracking in ResourceReference. More...
 
void addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference)
 
void removeNodeReference (const AbstractNodeReference &reference)
 
ScriptingContextSharedPtr getScriptingContext () const
 
void setScriptingContext (ScriptingContextSharedPtr context)
 
void setTemplateRoot (NodeSharedPtr templateRoot)
 Sets the template root of this node. More...
 
NodeSharedPtr getTemplateRoot () const
 Gets the template root of this node. More...
 
bool trySetActiveFocus ()
 The method tries to move the active focus on this node. More...
 
string getName () const
 Gets the value of NameProperty. More...
 
void setName (string_view value)
 Sets the value of NameProperty. More...
 
string getPath () const
 Gets the value of PathProperty. More...
 
void setPath (string value)
 Sets the value of PathProperty. More...
 
string getLocale () const
 Gets the value of LocaleProperty. More...
 
void setLocale (string value)
 Sets the value of LocaleProperty. More...
 
bool isHitTestable () const
 Gets the value of HitTestableProperty. More...
 
void setHitTestable (bool value)
 Sets the value of HitTestableProperty. More...
 
bool isHitTestableContainer () const
 Gets the value of HitTestableContainerProperty. More...
 
void setHitTestableContainer (bool value)
 Sets the value of HitTestableContainerProperty. More...
 
bool isVisible () const
 Gets the value of VisibleProperty. More...
 
void setVisible (bool value)
 Sets the value of VisibleProperty. More...
 
bool isEnabled () const
 Gets the value of EnabledProperty. More...
 
void setEnabled (bool value)
 Sets the value of EnabledProperty. More...
 
bool isFocusable () const
 Gets the value of FocusableProperty. More...
 
void setFocusable (bool value)
 Sets the value of FocusableProperty. More...
 
bool isFocused () const
 Gets the value of FocusedProperty. More...
 
void setFocused (bool value)
 Sets the value of FocusedProperty. More...
 
bool hasLogicalFocus () const
 Returns the #LogicalFocusedProperty value. More...
 
void setLogicalFocus (bool value)
 Sets the value of LogicalFocusProperty. More...
 
FontSharedPtr getFont () const
 Gets the value of FontProperty. More...
 
void setFont (FontSharedPtr value)
 Sets the value of FontProperty. More...
 
float getVisibleAmountInParent () const
 Gets the value of VisibleAmountInParentProperty. More...
 
void setVisibleAmountInParent (float value)
 Sets the value of VisibleAmountInParentProperty. More...
 
float getProjection2DTo3DScale () const
 Gets the value of Projection2DTo3DScaleProperty. More...
 
void setProjection2DTo3DScale (float value)
 Sets the value of Projection2DTo3DScaleProperty. More...
 
bool isEnableClick () const
 Gets the value of EnableClickProperty. More...
 
void setEnableClick (bool value)
 Sets the value of EnableClickProperty. More...
 
bool isEnableMultiClick () const
 Gets the value of EnableMultiClickProperty. More...
 
void setEnableMultiClick (bool value)
 Sets the value of EnableMultiClickProperty. More...
 
ResourceSharedPtr getStyle () const
 Gets the value of StyleProperty. More...
 
void setStyle (ResourceSharedPtr value)
 Sets the value of StyleProperty. More...
 
ResourceSharedPtr getStateManager () const
 Gets the value of StateManagerProperty. More...
 
void setStateManager (ResourceSharedPtr value)
 Sets the value of StateManagerProperty. More...
 
float getWidth () const
 Gets the value of WidthProperty. More...
 
void setWidth (float value)
 Sets the value of WidthProperty. More...
 
float getHeight () const
 Gets the value of HeightProperty. More...
 
void setHeight (float value)
 Sets the value of HeightProperty. More...
 
float getDepth () const
 Gets the value of DepthProperty. More...
 
void setDepth (float value)
 Sets the value of DepthProperty. More...
 
float getActualWidth () const
 Gets the value of ActualWidthProperty. More...
 
void setActualWidth (float value)
 Sets the value of ActualWidthProperty. More...
 
float getActualHeight () const
 Gets the value of ActualHeightProperty. More...
 
void setActualHeight (float value)
 Sets the value of ActualHeightProperty. More...
 
float getActualDepth () const
 Gets the value of ActualDepthProperty. More...
 
void setActualDepth (float value)
 Sets the value of ActualDepthProperty. More...
 
Node::HorizontalAlignment getHorizontalAlignment () const
 Gets the value of HorizontalAlignmentProperty. More...
 
void setHorizontalAlignment (Node::HorizontalAlignment value)
 Sets the value of HorizontalAlignmentProperty. More...
 
Node::VerticalAlignment getVerticalAlignment () const
 Gets the value of VerticalAlignmentProperty. More...
 
void setVerticalAlignment (Node::VerticalAlignment value)
 Sets the value of VerticalAlignmentProperty. More...
 
Node::DepthAlignment getDepthAlignment () const
 Gets the value of DepthAlignmentProperty. More...
 
void setDepthAlignment (Node::DepthAlignment value)
 Sets the value of DepthAlignmentProperty. More...
 
Vector2 getHorizontalMargin () const
 Gets the value of HorizontalMarginProperty. More...
 
void setHorizontalMargin (Vector2 value)
 Sets the value of HorizontalMarginProperty. More...
 
Vector2 getVerticalMargin () const
 Gets the value of VerticalMarginProperty. More...
 
void setVerticalMargin (Vector2 value)
 Sets the value of VerticalMarginProperty. More...
 
Vector2 getDepthMargin () const
 Gets the value of DepthMarginProperty. More...
 
void setDepthMargin (Vector2 value)
 Sets the value of DepthMarginProperty. More...
 
Node::ContentStretch getContentStretch () const
 Gets the value of ContentStretchProperty. More...
 
void setContentStretch (Node::ContentStretch value)
 Sets the value of ContentStretchProperty. More...
 
float getOpacity () const
 Gets the value of OpacityProperty. More...
 
void setOpacity (float value)
 Sets the value of OpacityProperty. More...
 
bool isHover () const
 Returns whether the node has HoverProperty set to true. More...
 
bool isClipChildren () const
 Gets the value of ClipChildrenProperty. More...
 
void setClipChildren (bool value)
 Sets the value of ClipChildrenProperty. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const KZ_OVERRIDE
 Returns the metaclass of the dynamic type of the object. More...
 
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
- Public Member Functions inherited from kanzi::MetaObject
virtual ~MetaObject ()
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
- Public Member Functions inherited from kanzi::PropertyObject
 PropertyObject ()
 
virtual ~PropertyObject ()
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property. More...
 
void removeKzbProperties ()
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
 
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
 Gets number of current notification handlers for given property type. More...
 

Static Public Member Functions

static TextBlock3DSharedPtr create (Domain *domain, string_view name)
 Creates a TextBlock3D node. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::TextBlockConceptImpl< Node3D, TextBlock3D >
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::Node3D
static float layoutUp ()
 
static bool isValidLayoutSize (Vector3 size)
 Indicates whether a size is valid layout size. More...
 
static Vector3 unboundedLayoutSize ()
 Returns an unbounded layout size. More...
 
static bool isUnboundedLayoutSize (Vector3 layoutSize)
 Indicates whether a layout size is an unbound layout size. More...
 
static Vector3 replaceUnboundedLayoutSize (Vector3 layoutSize, Vector3 resetSize)
 Replaces any element of a layout size with appropriate element of the reset size if it is unbounded and returns the size. More...
 
static Vector3 replaceUnboundedLayoutSizeWithZero (Vector3 layoutSize)
 Replaces any element of a layout size with zero if it is unbounded and returns the size. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::Node
static bool isValidLayoutValue (float value)
 Indicates whether a value is valid layout value. More...
 
static float unboundedLayoutValue ()
 Returns an unbounded layout value. More...
 
static bool isUnboundedLayoutValue (float layoutValue)
 Indicates whether a value is an unbound layout value. More...
 
static float replaceUnboundedLayoutValue (float layoutValue, float resetValue)
 Replaces layout value with the specified value if it is unbounded and returns it. More...
 
static float replaceUnboundedLayoutValueWithZero (float layoutValue)
 Replaces layout value with zero if it is unbounded layout value and returns it. More...
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::TextBlockConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Static Public Attributes

static const float DefaultTextLayoutDepth
 The size of the text block in Z-direction. More...
 
- Static Public Attributes inherited from kanzi::Node3D
static PropertyType< Matrix4x4FinalTransformationProperty
 FinalTransformation property. More...
 
static PropertyType< float > FrustumCullMarginProperty
 FrustumCullMargin property. More...
 
static PropertyType< SRTValue3DRenderTransformationProperty
 RenderTransformation property. More...
 
static PropertyType< SRTValue3DLayoutTransformationProperty
 LayoutTransformation property. More...
 
- Static Public Attributes inherited from kanzi::Node
static PropertyType< string > NameProperty
 Name property. More...
 
static PropertyType< string > PathProperty
 Path property. More...
 
static PropertyType< string > LocaleProperty
 Locale property. More...
 
static PropertyType< bool > CreatedFromKZBProperty
 CreatedFromKZB property. More...
 
static PropertyType< bool > HitTestableProperty
 HitTestable property. More...
 
static PropertyType< bool > HitTestableContainerProperty
 HitTestableContainer property. More...
 
static PropertyType< bool > VisibleProperty
 Visible property. More...
 
static PropertyType< bool > EnabledProperty
 Enabled property. More...
 
static PropertyType< bool > FocusableProperty
 The property specifies whether a node can get active focus and can participate in the focus chain navigation. More...
 
static PropertyType< bool > FocusedProperty
 Specifies that the node is the active focus node, which receives keyboard messages. More...
 
static PropertyType< bool > LogicalFocusProperty
 Specifies that the node has logical focus state. More...
 
static PropertyType< ResourceSharedPtrFontProperty
 Font property. More...
 
static PropertyType< float > VisibleAmountInParentProperty
 VisibleAmountInParent property. More...
 
static PropertyType< float > Projection2DTo3DScaleProperty
 Projection2DTo3DScale property. More...
 
static PropertyType< bool > EnableClickProperty
 EnableClick property. More...
 
static PropertyType< bool > EnableMultiClickProperty
 EnableMultiClick property. More...
 
static PropertyType< ResourceSharedPtrStyleProperty
 Style property. More...
 
static PropertyType< ResourceSharedPtrStateManagerProperty
 StateManager property. More...
 
static PropertyType< void * > PrefabTemplateSourceProperty
 PrefabTemplateSource property. More...
 
static PropertyType< float > WidthProperty
 Width property. More...
 
static PropertyType< float > HeightProperty
 Height property. More...
 
static PropertyType< float > DepthProperty
 Depth property. More...
 
static PropertyType< float > ActualWidthProperty
 ActualWidth property. More...
 
static PropertyType< float > ActualHeightProperty
 ActualHeight property. More...
 
static PropertyType< float > ActualDepthProperty
 ActualDepth property. More...
 
static PropertyType< Node::HorizontalAlignmentHorizontalAlignmentProperty
 HorizontalAlignment property. More...
 
static PropertyType< Node::VerticalAlignmentVerticalAlignmentProperty
 VerticalAlignment property. More...
 
static PropertyType< Node::DepthAlignmentDepthAlignmentProperty
 DepthAlignment property. More...
 
static PropertyType< Vector2HorizontalMarginProperty
 Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. More...
 
static PropertyType< Vector2VerticalMarginProperty
 Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. More...
 
static PropertyType< Vector2DepthMarginProperty
 Sets the space in the depth direction between this node and other nodes that are adjacent to this node in a layout. More...
 
static PropertyType< Node::ContentStretchContentStretchProperty
 ContentStretch property. More...
 
static PropertyType< float > OpacityProperty
 Opacity property. More...
 
static PropertyType< bool > HoverProperty
 Kanzi updates the HoverProperty for a hit testable node to indicate whether the node is the foremost node under the cursor. More...
 
static PropertyType< bool > ClipChildrenProperty
 ClipChildren property. More...
 
static PropertyType< int > SceneGraphAddNodeChangeChildFlagsProperty
 SceneGraphAddNodeChangeChildFlags property. More...
 
static PropertyType< int > SceneGraphAddNodeChangeParentFlagsProperty
 SceneGraphAddNodeChangeParentFlags property. More...
 
static PropertyType< int > SceneGraphRemoveNodeChangeChildFlagsProperty
 SceneGraphRemoveNodeChangeChildFlags property. More...
 
static PropertyType< int > SceneGraphRemoveNodeChangeParentFlagsProperty
 SceneGraphRemoveNodeChangeParentFlags property. More...
 
- Static Public Attributes inherited from kanzi::TextBlockConcept
static PropertyType< ColorRGBAFontColorProperty
 Use the Font Color property to set the text color for the default font material and for the materials with a fragment shader that uses the FontColor uniform. More...
 
static PropertyType< float > FontSizeProperty
 Use the Font Size property to set the size of the font in device-independent pixels. More...
 
static PropertyType< ResourceSharedPtrFontMaterialProperty
 Use the Font Material property to set the material whose shader is used to render the text. More...
 
static PropertyType< TextBlockConcept::TextHorizontalAlignmentTextHorizontalAlignmentProperty
 Use the Text Horizontal Alignment property to set the horizontal alignment of the text. More...
 
static PropertyType< TextBlockConcept::TextVerticalAlignmentTextVerticalAlignmentProperty
 Use the Text Vertical Alignment property to set the vertical alignment of the text. More...
 
static PropertyType< float > LineSpacingProperty
 Use the Line Spacing property to set the line spacing in multiples of the normal line height of the selected font. More...
 
static PropertyType< float > CharacterSpacingProperty
 Use the Character Spacing property to set the character spacing in device-independent pixels. More...
 
static PropertyType< string > OverflowProperty
 Use the Overflow property to set the characters that represent the clipped text when the text string to be rendered is too long to fit in the node. More...
 
static PropertyType< string > TextProperty
 Use the Text property to set the text content that the text block renders. More...
 
static PropertyType< bool > WordWrapProperty
 Use the Word Wrap property to break long text lines to multiple lines to make the text fit within the boundaries of the text block. More...
 
static PropertyType< bool > ConstrainContentHeightProperty
 Use the Constrain Content Height property to cut out the last lines that do not fit within the boundaries of the text block. More...
 
static PropertyType< float > FixedCharacterWidthProperty
 Use the Fixed Character Width property to override the font advance widths and make each character take a fixed amount of space specified in device-independent pixels. More...
 
static PropertyType< Vector2HorizontalPaddingProperty
 Use the Horizontal Padding property to set the padding spaces between the content and the left and right boundaries of the text block. More...
 
static PropertyType< Vector2VerticalPaddingProperty
 Use the Vertical Padding property to set the padding spaces between the content and the top and bottom boundaries of the text block. More...
 
static PropertyType< bool > RemoveSideBearingsProperty
 Use the Remove Side Bearings property to position the leftmost characters of left-aligned text and rightmost characters of right-aligned text exactly within the boundary of the text block. More...
 
static PropertyType< bool > FractionalCharacterWidthProperty
 Sets whether Kanzi uses fractional or rounded character widths to lay out text. More...
 
static PropertyType< bool > SnapCharacterToPixelProperty
 Sets whether Kanzi positions characters in 2D rendering to the nearest pixel: More...
 
static PropertyType< FontHintingPreferenceHintingPreferenceProperty
 Sets the hinting preference of the selected font. More...
 

Protected Member Functions

 TextBlock3D (Domain *domain, string_view name)
 Constructor. More...
 
void initialize ()
 Do TextBlock3D-specific initialization. More...
 
MaterialSharedPtr reattachMaterialRenderer ()
 Reattach material renderer if necessary and return current font material in use. More...
 
virtual void render (Renderer3D &renderer, const KzuTransformedObjectNode &transformedObjectNode, const Matrix4x4 &worldTransformation) KZ_OVERRIDE
 Node3D::render() implementation. More...
 
virtual const KzuBoundingVolumegetBoundingVolume () const KZ_OVERRIDE
 Node3D::getBoundingVolume() implementation. More...
 
virtual Vector3 measureOverride (Vector3 availableSize) KZ_OVERRIDE
 Node3D::measureOverride() implementation. More...
 
virtual void arrangeOverride (Vector3 actualSize) KZ_OVERRIDE
 Node3D::arrangeOverride() implementation. More...
 
virtual void onDetached () KZ_OVERRIDE
 Node3D::onDetached() implementation. More...
 
- Protected Member Functions inherited from kanzi::TextBlockConceptImpl< Node3D, TextBlock3D >
 TextBlockConceptImpl (Domain *domain, string_view name)
 Constructor. More...
 
void prepareTextFormat (float textFormatWidth, float textFormatHeight, bool constrainToActualSize)
 Position the text. More...
 
void prepareTextFormat (float textFormatWidth, float textFormatHeight, bool measure, bool ceiledSizes)
 Position the text. More...
 
virtual void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) KZ_OVERRIDE
 Node::onPropertyChanged implementation. More...
 
virtual void onPostPrepareTextFormatMeasure (bool completeRelayoutingExecuted)
 When in measure layouting phase, Kanzi calls this function every time it completes the prepareTextFormat function. More...
 
virtual void onPostPrepareTextFormatArrange (bool completeRelayoutingExecuted)
 When in arrange layouting phase, Kanzi calls this function every time it completes the prepareTextFormat function. More...
 
- Protected Member Functions inherited from kanzi::Node3D
 Node3D (Domain *domain, string_view name)
 
void initialize ()
 
virtual NodeSharedPtr findAbstractChildOverride (string_view name) KZ_OVERRIDE
 
virtual VisitorResult visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) KZ_OVERRIDE
 
virtual void renderOverride (RenderPass &renderPass, const KzuTransformedObjectNode &transformedNode)
 Node-specific render function which passes the control to the render pass which executes the rendering. More...
 
void setPrimitiveLayout (bool primitive)
 
- Protected Member Functions inherited from kanzi::Node
 Node (Domain *domain, string_view name)
 Constructor. More...
 
void initialize ()
 
virtual void onAttached ()
 Called when an object node becomes attached. More...
 
void updatePropertiesForConnectedNode ()
 Invokes property notifications for inherited properties during scene graph tree connections. More...
 
void updatePropertiesForDisconnectedNode (Node *oldParent)
 Invokes property notifications for inherited properties during scene graph tree disconnections. More...
 
void updateResourceReferences ()
 
void updateResourceReferences (AbstractPropertyType propertyType)
 
void updateResourceReferencesRecursive ()
 
void updateResourceReferencesRecursive (const ResourceID &resourceID)
 
void attach ()
 Attaches the object node. More...
 
void detach ()
 Detaches the object node. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason) KZ_OVERRIDE
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
 MetaObject ()
 
void initialize ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntryfindLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 
PropertyStorageContainer::iterator endPropertyStorage ()
 
void onCopy (const PropertyObject &other)
 

Properties

static PropertyType< float > BaselineProperty
 Baseline property. More...
 
static PropertyType< bool > TwoPassRenderingProperty
 TwoPassRendering property. More...
 
float getBaseline () const
 Gets the value of BaselineProperty. More...
 
bool isTwoPassRendering () const
 Gets the value of TwoPassRenderingProperty. More...
 
void setTwoPassRendering (bool value)
 Sets the value of TwoPassRenderingProperty. More...
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::Node
static VisitorResult updateResourceVisitor (Node &node, const ResourceID &id)
 
static VisitorResult updateAllResourcesVisitor (Node &node)
 
static VisitorResult applyStylesVisitor (Node &node, bool apply)
 
static VisitorResult attachVisitor (Node &node)
 
static VisitorResult detachVisitor (Node &node)
 
static VisitorResult validateDrawVisitor (Node &node)
 Visitor for validating draw. More...
 
static bool processPropertyChanged (Node &node, AbstractPropertyType propertyType, const PropertyStoragePtr &nodePropertyStorage, AbstractPropertyTypeDescriptor::PropertyStorage *changedPropertyStorage, PropertyNotificationReason reason)
 Processes notification handlers for node and property storage. More...
 
static VisitorResult propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, AbstractPropertyTypeDescriptor::PropertyStorage *propertyStorage, PropertyNotificationReason reason)
 
- Protected Attributes inherited from kanzi::TextBlockConceptImpl< Node3D, TextBlock3D >
FontSharedPtr m_cachedFont
 Font resource reference. More...
 
TextFormatSharedPtr m_textFormat
 The text layout for the glyphs that this node displays. More...
 
ClassPropertyDefaultValue< ResourceSharedPtrm_classValueFontMaterialProperty
 Default value for font material property. More...
 
ClassPropertyDefaultValue< ResourceSharedPtrm_classValueFontProperty
 Default value for font property. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Text Block 3D displays a small amount of text in 3D.

To render a Text Block 3D node Kanzi:

  1. Prepares the text as 2D text using device-independent pixel metrics.
  2. Projects the prepared text to 3D space using the value of Node::Projection2DTo3DScaleProperty to scale device-independent pixels to 3D units.

Use device-independent pixel values to set the values of text block specific properties such as TextBlockConcept::FontSizeProperty or TextBlockConcept::FixedCharacterWidthProperty.

Use 3D units to adjust the layout of a Text Block 3D node in 3D space. For example, use 3D units to set the values of the Node::WidthProperty and Node::HeightProperty properties in a Text Block 3D node.

Text Block 3D does not support clipping.

See also
For a 2D text node, see TextBlock2D.

Examples

To create a Text Block 3D node:

// Create a Text Block 3D node named Text Block.
TextBlock3DSharedPtr textBlock = TextBlock3D::create(domain, "Text Block");

To set the font of a text block:

// Set the font used by the Text Block node using the resource ID.
textBlock->setFont(font);

To add the text shown by a text block:

// Set the text in the Text Block node to Hello world!.
textBlock->setText("Hello\nworld!");

To adjust the appearance of the text:

// Set the style of the text in a Text Block 3D node:
// Set the size of the font to 90 device-independent pixels.
textBlock->setFontSize(90.0f);
// Set the color of the font to blue.
textBlock->setFontColor(ThemeBlue);
// Set the width of the text block in 3D space to 4 3D units.
textBlock->setWidth(4.0f);
// Set the height of the text block in 3D space to 5 3D units.
textBlock->setHeight(5.0f);
// To break long text lines to multiple lines to make the text fit within
// the boundaries of the text block, set the Word Wrap property to true.
textBlock->setWordWrap(true);
// To cut out the last lines that do not fit within the boundaries of the text block,
// set the Constrain Content Height property to true.
textBlock->setConstrainContentHeight(true);
// Align the text in the text block to the right.
textBlock->setTextHorizontalAlignment(TextBlockConcept::TextHorizontalAlignmentRight);

To adjust the scaling factor of the 2D to 3D projection:

// To scale the final text in 3D space, set the 2D to 3D projection scaling factor to 0.04.
// The default value of the Node::Projection2DTo3DScaleProperty property is 0.02f.
textBlock->setProjection2DTo3DScale(0.04f);

Member Typedef Documentation

Constructor & Destructor Documentation

virtual kanzi::TextBlock3D::~TextBlock3D ( )
virtual

Destructor.

kanzi::TextBlock3D::TextBlock3D ( Domain domain,
string_view  name 
)
explicitprotected

Constructor.

Parameters
domainThe UI domain the new node belongs to.
nameThe name of the node.

Member Function Documentation

float kanzi::TextBlock3D::getBaseline ( ) const
inline

Gets the value of BaselineProperty.

See also
setBaseline()
bool kanzi::TextBlock3D::isTwoPassRendering ( ) const
inline

Gets the value of TwoPassRenderingProperty.

See also
setTwoPassRendering()
void kanzi::TextBlock3D::setTwoPassRendering ( bool  value)
inline

Sets the value of TwoPassRenderingProperty.

See also
isTwoPassRendering()
static TextBlock3DSharedPtr kanzi::TextBlock3D::create ( Domain domain,
string_view  name 
)
static

Creates a TextBlock3D node.

Parameters
domainThe UI domain the new node belongs to.
nameThe name of the node.
Returns
The created node.
static PropertyTypeEditorInfoSharedPtr kanzi::TextBlock3D::makeEditorInfo ( )
static
virtual void kanzi::TextBlock3D::restoreResources ( )
virtual

Node::restoreResources() implementation.

Reimplemented from kanzi::Node.

MaterialRenderer* kanzi::TextBlock3D::getMaterialRenderer ( )
inline

Access material renderer.

Returns
Material renderer.
TextureSharedPtr kanzi::TextBlock3D::getGlyphTexture ( ) const

Access glyph texture.

Returns
Glyph texture.
void kanzi::TextBlock3D::initialize ( )
protected

Do TextBlock3D-specific initialization.

MaterialSharedPtr kanzi::TextBlock3D::reattachMaterialRenderer ( )
protected

Reattach material renderer if necessary and return current font material in use.

Will do nothing if material renderer is already attached to the correct material.

Returns
Current font material.
virtual void kanzi::TextBlock3D::render ( Renderer3D renderer,
const KzuTransformedObjectNode transformedObjectNode,
const Matrix4x4 worldTransformation 
)
protectedvirtual

Node3D::render() implementation.

Reimplemented from kanzi::Node3D.

virtual const KzuBoundingVolume* kanzi::TextBlock3D::getBoundingVolume ( ) const
protectedvirtual

Node3D::getBoundingVolume() implementation.

Reimplemented from kanzi::Node.

virtual Vector3 kanzi::TextBlock3D::measureOverride ( Vector3  availableSize)
protectedvirtual

Node3D::measureOverride() implementation.

Reimplemented from kanzi::Node3D.

virtual void kanzi::TextBlock3D::arrangeOverride ( Vector3  actualSize)
protectedvirtual

Node3D::arrangeOverride() implementation.

Reimplemented from kanzi::Node3D.

virtual void kanzi::TextBlock3D::onDetached ( )
protectedvirtual

Node3D::onDetached() implementation.

Reimplemented from kanzi::Node.

Member Data Documentation

const float kanzi::TextBlock3D::DefaultTextLayoutDepth
static

The size of the text block in Z-direction.

Used when constructing the text bounding box. By default, this value is insignificant as compared to normal layout sizes.

PropertyType<float> kanzi::TextBlock3D::BaselineProperty
static

Baseline property.

Font baseline in 3D space units. The default value is 0.0f.

See also
setBaseline(), getBaseline()
PropertyType<bool> kanzi::TextBlock3D::TwoPassRenderingProperty
static

TwoPassRendering property.

Defines whether the Text Block 3D is rendered in two passes. Disabling the two pass rendering improves performance, but can cause invalid rendering result when glyph bounds overlap. The default value is true.

See also
setTwoPassRendering(), isTwoPassRendering()

The documentation for this class was generated from the following file: